Interface LockingTree

All Superinterfaces:
IPCObject
All Known Implementing Classes:
LockingTreeImpl

public interface LockingTree extends IPCObject
Information provided by the PKI file:

    \class LockingTree
    
    \brief LockingTree handles and manipulates the activity file locking tree.
    
    \example appWindow().getActiveFile().getLockingTree()
    
Author:
Auto-generated
  • Method Details

    • setLock

      boolean setLock(String ID, String branchID1, String branchID2, boolean locked)
      Information provided by the PKI file:
      
          \brief Locks or unlocks the specified locking item.
          
          \param ID, the name of the locking item.
          \param branchID1, the name from branch 1 (default is empty).
          \param branchID2, the name from branch 2 in branch 1 (default is empty).
          \param locked, true to lock the item, false to unlock the item.
          
              
      Parameters:
      ID - Takes in a parameter of ID
      branchID1 - Takes in a parameter of branchID1
      branchID2 - Takes in a parameter of branchID2
      locked - Takes in a parameter of locked
      Returns:
      boolean Returns a boolean
    • isLocked

      boolean isLocked(String ID, String branchID1, String branchID2)
      Information provided by the PKI file:
      
          \brief Returns true if the specified item is locked, otherwise false.
          
          \param ID, the name of the locking item.
          \param branchID1, the name from branch 1 (default is empty).
          \param branchID2, the name from branch 2 in branch 1 (default is empty).
          
              
      Parameters:
      ID - Takes in a parameter of ID
      branchID1 - Takes in a parameter of branchID1
      branchID2 - Takes in a parameter of branchID2
      Returns:
      boolean Returns a boolean